Skip to main content

DescribeDdosPolicies

Description

query the configured DDoS protection policy.

Request Method

POST

Request Path

/apsara/route/Ddosprivate/DescribeDdosPolicies

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
PageSizeBODYintegerNoNo sample value for this parameter.specifies the maximum number of records displayed on the page.
CurrentPageBODYintegerNoNo sample value for this parameter.specifies the current page number returned.
regionIdBODYstringYesNo sample value for this parameter.region id
versionBODYstringNo2016-01-01version of api

Return data

NameTypeSample valueDescription
PackageRateintegerno demo valueearly warning packet speed (unit: pps).
TotalCountintegerno demo valuereturns the total number of pages.
HttpRateintegerno demo valuealert HTTP request rate (unit: QPS).
CodeNamestringno demo valuethe name of the region to which the network segment corresponding to the DDoS policy belongs.
RequestIdstringno demo valuerequest ID.
PageSizeintegerno demo valuepage displays the maximum number of records.
CurrentPageintegerno demo valuecurrently returns page number.
ExternalServiceIPstringno demo valueIP or IP network segment corresponding to DDoS policy.
DepartmentNamestringno demo valueDDoS policy creates the department corresponding to user Aliuid.
DdosPoliciesarrayno demo valueDDoS policy list information. For specific sub-item descriptions, see the following parameter descriptions.
Codestringno demo valueThe region code of the network segment corresponding to the DDoS policy.
FlowRateintegerno demo valuewarning flow rate (unit: Mbps).

Example

Successful Response example

{
"PackageRate":"no demo value",
"TotalCount":"no demo value",
"HttpRate":"no demo value",
"CodeName":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"ExternalServiceIP":"no demo value",
"DepartmentName":"no demo value",
"DdosPolicies":"no demo value",
"Code":"no demo value",
"FlowRate":"no demo value"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}